home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / UTILITY / FCOM21.ARJ / FCOM.DOC < prev    next >
Text File  |  1992-05-06  |  17KB  |  394 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                                   FCOM 2.1
  13.                            -  The File Combine  -
  14.  
  15.                        (c)Copyright 1992 Rand Nowell
  16.  
  17.  
  18.                              RaLin Enterprises
  19.                        "Putting Little Bits Together" (tm)
  20.  
  21.                     40728 Sundale Dr. Fremont, Ca. 94538
  22.                                (510) 651-0253
  23.  
  24.  
  25.  
  26.  
  27.  
  28.                          - Program Documentation -
  29.                           - Typeset May 6, 1992 -
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                               - Manual Index -
  37.  
  38.  
  39.                   Copyright,Legal Stuff.................1
  40.                   System Requirements...................1
  41.                   Command Syntax........................2
  42.                   Speed Figures.........................2
  43.                   Program Prompts.......................2
  44.                   Sample.Bat............................2
  45.                   Append Form Feeds.....................2
  46.                   Overwrite File........................2
  47.                   Print the File......................2,3
  48.                   Errors................................3
  49.                   FCFILE.BAK............................3
  50.                   File Not Found........................3
  51.                   Print and View........................4
  52.                   Appending to File.....................4
  53.                   The Future of FCOM....................6
  54.                   Why Register..........................6
  55.                   Support...............................7
  56.  
  57.  
  58. FCOM.DOC                  Program Documentation                     Page 1
  59.  
  60.     FCOM 2.1 - Is NOT Public Domain, Nor Free,It is being distributed under
  61.     the shareware concept. This means that you are free try the program for
  62.     a specified time and evaluate is usefulness to you. Should you find
  63.     the program a valuable asset and wish to continue using it a
  64.     registration fee is usually in order.
  65.  
  66.                             - The Legal Stuff -
  67.  
  68.     FCOM.EXE the Combine program, and FCOM.DOC the documentation,
  69.     are all the Copyrighted work of the author:
  70.     Rand Nowell dba RaLin Enterprises.
  71.  
  72.     You are licensed to use this program, as long as it is not modified.
  73.     Please do not disassemble, recompile or otherwise change
  74.     the visable or mechanical format of FCOM.
  75.  
  76.     While, as stated above, you are licensed to use this program, doing
  77.     so beyond a TWO WEEK evluation period causes the Registration Fee to
  78.     be due the Author. I feel that two weeks should be a sufficient period
  79.     to allow you to determine if this program "meets your needs".
  80.     If it does, and you wish to continue to use FCOM  beyond the
  81.     two week period, Please Register It! This will induce me to further
  82.     enhance the program, and also bring you new versions at a savings
  83.     from normal registration.
  84.  
  85.     This SHAREWARE copy of FCOM may be freely distibuted as long as you
  86.     distribute the program with all accompanying documentation and sample
  87.     files. You may not modify any of the above either. Adding a comment
  88.     text file is allowed, as long as it is seperate from the authors files,
  89.     and states that it is a "USERS" comment.
  90.  
  91.     Distribution of the REGISTERED version of FCOM violates Federal
  92.     Copyright laws and should not be done. Support the Shareware Concept!
  93.  
  94.                                - DISCLAIMER -
  95.  
  96.     FCOM 2.1 is supplied "AS IS" and no warranties are expressed or implied.
  97.     Rand Nowell, the author, and RaLin Enterprises, the authors
  98.     company assume no liabilities for the use of this program. Much
  99.     effort has gone into providing a "BUG" free program, but the user
  100.     assumes all risk for its use.
  101.  
  102.                      OK, thats enough of this stuff....
  103.  
  104.     System Requirements:
  105.  
  106.            Hard Disk
  107.            Dos ver 3.0 or above
  108.            Memory: Suggest 300k, FCOM reads files 1 line of 132
  109.                    charecters at a time, then writes that line to NEW
  110.                    file. More DISK intensive than MEMORY intensive.
  111.                    Consequently a fast hard disk will get you faster
  112.                    combine times.
  113.           Printer: If you want to be able to print files.
  114.           Monitor: So far all tests show that FCOM will operate on both
  115.                    Color and Mono monitors. FCOM writes directly to video,
  116.                    so older CGA's "MAY" experience some "snow".
  117.  
  118. FCOM.DOC                  Program Documentation                     Page 2
  119.  
  120.     FCOM is a utility to combine multiple text files into one large text
  121.     file. It was designed to be used on text files, but will probably work
  122.     with binary files too. But this is NOT reccomemded, it wouldn't do you
  123.     much good and it would most likely stop at the first End-Of-File it
  124.     encoutered, of which there are usually several, in binary files.
  125.     So lets just use it for what it was designed for....Text files!
  126.  
  127.     FCOM is not a super fast "speed demon", but it gets the job done!
  128.     The largest file test I have performed was to combine two BBS listings,
  129.     one at 216,261(k) and one at 151,893(k) a total of 368,154(k)
  130.     into one file, and that took aprox 1 min 20 secs.
  131.  
  132.     Command Syntax:
  133.  
  134.     FCOM by itself with no parameters will generate a screen of
  135.     instructions, with the proper syntax and examples shown.
  136.  
  137.     Three sample text files have been provided for you to experiment with.
  138.     If you have already read the READTHIS.1st file, then you have run
  139.     SAMPLE.BAT and seen a demonstration of FCOM.
  140.  
  141.     To combine these three files; File1 File2 and File3 into one file called
  142.     NEW (or any other name) you would type, at the command line:
  143.  
  144.     C:> FCOM NEW File1 File2 File3 (Seperate names with a space only)
  145.  
  146.     FCOM will accept \Path\Filenames as parameters. The NEW \path\file is
  147.     limited to 64 charecters. The input files may also be \path\filenames.
  148.     The number of input files is limited to a command line length of
  149.     126 charecters, including the NEW file spec.
  150.     The first filename is the name you want to assign your NEW file, the
  151.     filenames after that are the existing files that you want to combine.
  152.     When entering the input filenames, type them in the order you want them
  153.     to be put into the single NEW file.
  154.  
  155.     Before FCOM starts the combine process you will be asked if you would
  156.     like a Form Feed appended to the end of each INPUT file. Depending on
  157.     your situation this could be useful. You answer this prompt by either
  158.     pressing <Y> for Yes,append form Feeds or <N> for No, do not append form
  159.     feeds.
  160.  
  161.     Next FCOM will ask if you'd like to Print the completed file. If you
  162.     press <Y> for yes, FCOM will print your completed file.
  163.     Please be sure your printer is on. If its not FCOM will ask you to turn
  164.     it on, then continue. Next you will be asked if you'd like to view the
  165.     new file when done, answer same as above.
  166.  
  167.     After you have answered these questions you will see the message
  168.     Combining Files....... as FCOM does its job.
  169.  
  170.     If the first filename, that you specified for your NEW file already
  171.     exsits, you will be asked for permission to overwrite it. Answering <Y>
  172.     for Yes will allow FCOM to proceed and overwrite the existing copy,
  173.     pressing <N> for No, will end the program, your existing file will be
  174.     untouched and the combining process will be aborted.
  175.     If <Y> was pressed to allow overwrite, FCOM displays a message saying
  176.     Overwrite Confirmed... often you will not see this message, if the file
  177.     being overwritten is small. Sometimes it just flashes by......
  178.  
  179.  
  180. FCOM.DOC                  Program Documentation                     Page 3
  181.  
  182.     If you tell FCOM to Overwrite the existing file, it first backs up
  183.     the original to a file named FCFILE.BAK. This is explained further
  184.     in the next section ERRORS.
  185.  
  186.     Once the combine process has been completed, FCOM will display a messgae
  187.     telling you Files Have Been Combined.....
  188.  
  189.  
  190.     ERRORS:
  191.  
  192.     There is really only one error that FCOM reports, should you include the
  193.     name of a file that does not exist, for input into your new file, FCOM
  194.     will beep and display an ERROR! message, and ask you to press Enter.
  195.     FCOM will abort and erase the NEW file, as it will not be complete!
  196.  
  197.     Whenever you tell FCOM to OVERWRITE the existing file, it will first
  198.     copy the original to a backup file. This file is named FCFILE.BAK.
  199.     Then if FCOM aborts, because you typed an invalid file name for a input
  200.     file, even though it deletes the master file that you told it to create,
  201.     you can recover your original data by renaming FCFILE.BAK, then you can
  202.     start the process over again.
  203.  
  204.     If you have a LOT of files you want to combine into ONE file, you can
  205.     lessen the chance of input file name mistakes by creating a simple batch
  206.     file. Call the batch something like MAKEIT, MASTER, BOOK or whatever.
  207.     then in the batch file enter the same thing you would at the command
  208.     prompt, but you will have the chance to exit and double check file
  209.     names. Just be sure to remember FCOM's limits, the NEW file is limited
  210.     to 64 charecters, and the complete command is limited to 126 charecters,
  211.     includeing the NEW file spec.
  212.     This is one of the problems that will be remedied in a future release of
  213.     FCOM, ie we want to add the option of using *.txt *.doc or *.*
  214.  
  215.  
  216. FCOM.DOC                  Program Documentation                     Page 4
  217.  
  218.    Print and View:
  219.  
  220.    FCOM uses its own internal print and view programs.
  221.  
  222.    When you begin the view, FCOM will display 22 lines of the file, then
  223.    prompt you to press SPACEBAR to continue or ESC to abort. Pressing the
  224.    spacebar will display the next 22 lines to the screen. Displaying only 22
  225.    lines this way always keeps the bottom two lines on the screen, sort of
  226.    an overlap effect. You won't miss anything this way. If you press ESC,
  227.    FCOM will go directly to the Printing of your NEW file.
  228.  
  229.    You will be asked if you want to continue with the print job, this allows
  230.    you to abort, in case you saw a problem while viewing. Then you can go
  231.    back, fix the problem, and re-combine.
  232.  
  233.    Appending:
  234.  
  235.    FCOM does not have, at present, the option to append vs overwrite the
  236.    new file. But you can accomplish this by re-combining. Assuming your
  237.    original file is TEST.TXT, rename to TEST1.TXT then enter:
  238.    FCOM Test Test1.txt file1 file2 file3.......file? This will effectivly
  239.    "append" the original and new files together into a 'modified' file TEST.
  240.  
  241.    I know its a hassle, but at present its the only way. A future version of
  242.    FCOM will address this option to append files.
  243.  
  244.  
  245. FCOM.DOC                  Program Documentation                     Page 5
  246.  
  247.     The Future:
  248.  
  249.     Future enhancements for FCOM:
  250.  
  251.     I mentioned in the documentation for FCOM 1.1 that I was working on
  252.     having settings passed from the command line, as Formfeeds yes or no,
  253.     printing yes or no etc. I have decided against this. There is less
  254.     confusion, and less chance for mistakes if the settings are prompted
  255.     for, by the program, within the program.
  256.  
  257.     In mind for a future release, is the ability to combine multiple files
  258.     using wildcards, such as *.TXT , *.DOC etc.
  259.  
  260.     As mentioned earlier, some CGA monitors may experience "snow" due to
  261.     FCOM's writing directly to video. Since there are not a whole bunch of
  262.     these monitors out there, I have left things as they are. But if users
  263.     notify me of an ongoing problem with this, I'll put in a fix to allow
  264.     configuration for older CGA systems.
  265.  
  266.     A future version of FCOM will allow you the option of appending new
  267.     files to an existing file, instead of deleting (after backup) the file.
  268.     And I have a couple of ideas for other enhancements too, but for now
  269.     they will remain my secret. heh heh!
  270.  
  271.  
  272.     NOTE: FCOM tries to let you know what its doing most all the time.
  273.     But when files being combined or printed are small the information
  274.     messages it displays may just flash by! But on bigger combine or print
  275.     jobs, these messages will let you know what FCOM is up to currently.
  276.  
  277.  
  278.  
  279. FCOM.DOC                  Program Documentation                     Page 6
  280.  
  281.    Why Register?
  282.  
  283.    There are several reasons to Register:
  284.  
  285.    1. You will receive a new copy of FCOM on disk. If there is a newer
  286.       version than the one you have, you'll get it. The copy you receive
  287.       will not have any annoying SHAREWARE screens bugging you.
  288.  
  289.    2. You will be entered as a registered user of FCOM.
  290.         This will get you notifed of new program releases, and if you
  291.         have a modem, will get you pre-registered on our BBS.
  292.         * The BBS is not online yet, but we hope to have it up
  293.         * in the next few months.
  294.  
  295.    3. Along with your new copy of FCOM, you'll receive a standalone version
  296.       of the viewer and print portions of FCOM. The Simple Viewer is better
  297.       than using the DOS more command, and the Simple Printer is better than
  298.       using the DOS type or copy to prn.
  299.       You will also receive QDC, Quick Directory Change. This is a simple
  300.       but FAST changer for multiple directory level changes.
  301.       I think you'll find them very useful!
  302.  
  303.    4. You will receive a DISCOUNTED upgrade to the next major version
  304.       release of FCOM. Minor fixes to the program will be sent to all
  305.       registered users.
  306.  
  307.  
  308.    5. Full Support.
  309.       Registered users get full support, if you call and I am not in, I will
  310.       return your call at my expense. Unregistered users will receive a
  311.       collect call, and after any calls to Registered users.
  312.  
  313.  
  314.  
  315.    To register FCOM 2.1 fill out and mail the Registration Form on the last
  316.    page.
  317.  
  318.                            Thanks for using FCOM!
  319.  
  320. FCOM.DOC                  Program Documentation                     Page 7
  321.  
  322.   SUPPORT:
  323.  
  324.      I can be reached several ways. If calling by phone: If I am not in, or
  325.      you get an answering machine, please leave your name, phone, program
  326.      name and version and brief description of the problem, or question.
  327.      If you call on the weekend, I may not return your call until the next
  328.      weekday. But I WILL call soon as possible.
  329.      I return REGISTERED users calls at MY expense....others be prepared for
  330.      a COLLECT call.
  331.  
  332.      Voice Phone:  (510) 651-0253         : Ask for Rand
  333.  
  334.      Net Mail:  1:215/777  -or- 1:161/42  : Rand Nowell
  335.  
  336.      FidoNet Shareware Echo               : Rand Nowell
  337.  
  338.      Compuserve User ID: 76124,761
  339.      Note on Compuserve: I do not check Compuserve every day, usually
  340.      once a week. The above methods are quicker.
  341.  
  342.      US Mail:    Rand Nowell
  343.                  RaLin Enterprises
  344.                  40728 Sundale Dr.
  345.                  Fremont, Ca. 94538
  346.  
  347.  
  348.  
  349.                            - RaLin Enterprises -
  350.                            - Registration Form -
  351.  
  352.    Program: FCOM 2.1
  353.  
  354.    Yes, register FCOM 2.1 to me, and add me to your list. I will also be
  355.    eligible to receive the next major version of FCOM at a DISCOUNTED price.
  356.    And pre-register me on your Support BBS if the Modem? box is marked Yes!
  357.    ( When its On Line.....SOON I HOPE!! )
  358.  
  359.    Name:       ______________________________________________
  360.  
  361.    Address:    ______________________________________________
  362.  
  363.                _______________________________________________
  364.  
  365.    City:       _______________________________________________
  366.  
  367.    Province:   _______________________________________________
  368.  
  369.    State:      ____________________  Postal/Zip Code: ________________
  370.  
  371.    Phone:      ___________________________________________
  372.  
  373.    Do You Have a Modem?  Yes( ) No( )
  374.  
  375.    Registration must be paid in U.S. Dollars
  376.  
  377.  
  378.      FCOM 2.1 Registration   Quan_______ @ $10.00   Amount _____________
  379.  
  380.                                Orders outside the U.S. Add       $5.00
  381.  
  382.                                              Total:         ____________
  383.  
  384.     Mail payment and completed registration form to:
  385.  
  386.                              RaLin Enterprises
  387.                         40728 Sundale Dr.  Dept FCOM
  388.                              Fremont, Ca. 94538
  389.  
  390.                Our Voice Phone: (510) 651-0253  ask for Rand
  391.  
  392.  
  393.  
  394.